NEW Publishing and rendering options

You are here: VBScript reference > Publishing and rendering options

Appendix E: NEW

Publishing and rendering options

When documents are registered by the source vault's VBScript event handlers, publishing options and rendering options can be specified that modify the publishing job. These options can be set using the RegisterDocument method described in RegisterDocument method.

The BC Meridian system link supports the options described in the following table when the destination system is another Meridian Enterprise vault. The publishing options are not supported by the Windows file system link or the PDF Merge rendering module.

Note If an option accepts a value and the value is empty, the publishing job settings are used. If the value is invalid (missing < or > characters), the job will fail.

Publishing options
Option	Description
_CDWF_ <WorkflowDefinitionName ;WorkflowStateName>_	The document is published to the destination system immediately into the specified workflow state.
_DATAONLY_	The document content is not transmitted, only the property values. This option is typically used together with the _NORENDER_ option.
_DELETE_	The document is deleted from SharePoint libraries when the Meridian Enterprise source document is deleted. Warning Due to the risk of accidental data loss, this option is only available if the EnablePurgeOption value in the following registry key is set to 1. Be certain that you want to use this option before enabling it. HKEY_LOCAL_MACHINE\SOFTWARE\BlueCielo ECM Solutions\Publisher \BlueCieloECM.Adapters.SharePoint.SourceAdapter
NEW _LIB_<Title>_	The title of the SharePoint library to publish to. If specified, the value replaces both the Library option that is configured in the publishing job as described in Configuring the Microsoft SharePoint destination options. Note This option is supported by the SharePoint publishing module only.
NEW _NOREDLINES_	Prevents the publishing of redlines.
_NORELEASE_	The document is not released in the destination vault after publishing.
NEW _OVERWRITE_	If any revisions of the document exist in the destination system, they are deleted before the current revision from the source system is published. Note This option is supported by the SharePoint publishing module only.
NEW _RESERVE_ OR _RESERVE_<FileName> OR _RESERVE_<Path>	Checks the document out in the destination system, creating a new major or minor revision depending on the system configuration. The revision can be revoked and the new revision deleted by the _UNRESERVE_ option. Notes This option is supported by the SharePoint publishing module only. If the destination filename or path are not specified, the name of the document registered for publishing is used. The document will be checked out by the Publisher system account. Do not use with the _UNRESERVE_ or _DELETE_ options in the same operation or only the first option will be applied.
_RETIRE_	The document is not published to the destination system, but the existing document in the destination vault is retired.
NEW _RETRY_<Count>_	If the job fails for any reason, restart the job in the queue <Count> times or until the job succeeds, whichever comes first. Note This option overrides the global RetryCount setting described in Retrying failed jobs.
NEW _SITE_<URL>_	The URL of the SharePoint site and subsite to publish to. If specified, the value replaces both the Site address and the Subsite options that are configured in the publishing job as described in Configuring the Microsoft SharePoint destination options. Note This option is supported by the SharePoint publishing module only.
NEW _UNRESERVE_ OR _UNRESERVE_<FileName> OR _UNRESERVE_<Path>	Revokes the checkout of the specified document in the destination system and deletes the unreleased revision. Notes This option is supported by the SharePoint publishing module only. If the destination filename or path are not specified, the name of the document registered for publishing is used. Do not use with the _UNRESERVE_ option in the same operation or only the first option will be applied.

Publishing options

Option

Description

_CDWF_
<WorkflowDefinitionName
;WorkflowStateName>_

The document is published to the destination system immediately into the specified workflow state.

_DATAONLY_

The document content is not transmitted, only the property values. This option is typically used together with the _NORENDER_ option.

_DELETE_

The document is deleted from SharePoint libraries when the Meridian Enterprise source document is deleted.

Warning Due to the risk of accidental data loss, this option is only available if the EnablePurgeOption value in the following registry key is set to 1. Be certain that you want to use this option before enabling it.

HKEY_LOCAL_MACHINE\SOFTWARE\BlueCielo ECM Solutions\Publisher
\BlueCieloECM.Adapters.SharePoint.SourceAdapter

NEW

_LIB_<Title>_

The title of the SharePoint library to publish to. If specified, the value replaces both the Library option that is configured in the publishing job as described in Configuring the Microsoft SharePoint destination options.

Note This option is supported by the SharePoint publishing module only.

NEW

_NOREDLINES_

Prevents the publishing of redlines.

_NORELEASE_

The document is not released in the destination vault after publishing.

NEW

_OVERWRITE_

If any revisions of the document exist in the destination system, they are deleted before the current revision from the source system is published.

Note This option is supported by the SharePoint publishing module only.

NEW

_RESERVE_

_RESERVE_<FileName>

_RESERVE_<Path>

Checks the document out in the destination system, creating a new major or minor revision depending on the system configuration. The revision can be revoked and the new revision deleted by the _UNRESERVE_ option.

Notes

This option is supported by the SharePoint publishing module only.
If the destination filename or path are not specified, the name of the document registered for publishing is used.
The document will be checked out by the Publisher system account.
Do not use with the _UNRESERVE_ or _DELETE_ options in the same operation or only the first option will be applied.

_RETIRE_

The document is not published to the destination system, but the existing document in the destination vault is retired.

NEW

_RETRY_<Count>_

If the job fails for any reason, restart the job in the queue <Count> times or until the job succeeds, whichever comes first.

Note This option overrides the global RetryCount setting described in Retrying failed jobs.

NEW

_SITE_<URL>_

The URL of the SharePoint site and subsite to publish to. If specified, the value replaces both the Site address and the Subsite options that are configured in the publishing job as described in Configuring the Microsoft SharePoint destination options.

Note This option is supported by the SharePoint publishing module only.

NEW

_UNRESERVE_

_UNRESERVE_<FileName>

_UNRESERVE_<Path>

Revokes the checkout of the specified document in the destination system and deletes the unreleased revision.

Notes

This option is supported by the SharePoint publishing module only.
If the destination filename or path are not specified, the name of the document registered for publishing is used.
Do not use with the _UNRESERVE_ option in the same operation or only the first option will be applied.

Supported formats

Format

Description

_PAGERANGE_<>_

Current page

_PAGERANGE_<;>_

All pages

_PAGERANGE_<n;n>_

Pages n to n

_PAGERANGE_<n;>_

Page n to the end of the document

Related concepts

Understanding the BlueCielo Meridian Enterprise system link

Configuring BlueCielo Meridian Enterprise destination options


	BlueCielo Publisher 2012 Administrator's Guide \| BlueCielo ECM Solutions